home *** CD-ROM | disk | FTP | other *** search
/ Almathera Ten Pack 3: CDPD 3 / Almathera Ten on Ten - Disc 3: CDPD3.iso / scope / 126-150 / scopedisk131 / diskinfo / diskinfo.doc < prev    next >
Text File  |  1995-03-19  |  23KB  |  437 lines

  1.  
  2. DiskInfo v5.0   Copyright © 1990 by Stan Ziel, all rights reserved.
  3.  
  4.  
  5.     This document contains the following sections:
  6.  
  7.     Overview          - A quick look at what DiskInfo is
  8.     Usage             - Starting, stopping, and using DiskInfo
  9.     Options           - Command-line options to customize DiskInfo
  10.     Considerations    - Bugs (there are none!), precautions, and so on
  11.     DiskInfo & FFS    - Specific info for using DiskInfo with FFS floppies
  12.     FFS Floppies      - A more detailed look at FFS floppies
  13.     Program Notes     - History and notes for the curious
  14.     Credits, etc.     - Special thanks, and how to contact me
  15.  
  16.  
  17. OVERVIEW
  18. --------
  19.     DiskInfo is a utility (actually two utilities in one) designed for use
  20. from the CLI or in your startup-sequence.  It will not run directly from
  21. the WorkBench.  DiskInfo's main purpose is to display what floppy drives
  22. (3.5") are mounted, and how many free-blocks remain on each one.  The
  23. second function of DiskInfo is to make it easier to use FFS-floppy disks
  24. with WorkBench 1.3.  It does this by indicating when a FFS-floppy is in a
  25. drive, and performing a DiskChange on that drive when disks are swapped.
  26. However, you do not need to use FFS-floppies in order to use DiskInfo.
  27.  
  28.  
  29. USAGE
  30. -----
  31.     Before you can use DiskInfo, you must copy it to your boot floppy or
  32. hard drive.  SYS:System is a good place for utilities such as DiskInfo.
  33. If you do this, you may have to specify a full pathname to DiskInfo when
  34. using it.  Since DiskInfo is intended for use from your startup-sequence,
  35. this should not be inconvenient.  If it is, you may want to copy DiskInfo
  36. to a directory in your path, such as C:.  You also must have the
  37. arp.library (v39 or higher) in your LIBS:  directory.
  38.  
  39.     Once this is done, just type "DiskInfo" at the CLI prompt, including a
  40. path as needed.  DiskInfo will start up and detach itself from the CLI.
  41. There is no need to "Run" DiskInfo, and you can close the CLI window that
  42. started DiskInfo.  Once you have DiskInfo working the way you want it, you
  43. might want to add the DiskInfo command to your startup-sequence.
  44.  
  45.     When DiskInfo starts, it checks to see what floppy drives are in your
  46. system, and if any of these are mounted as FFS units.  If any FFS units
  47. are mounted, DiskInfo activates them by doing a DiskChange on each one.
  48. This DiskChange is never done if a drive is not mounted as a FFS unit.
  49. All floppy drives are found automagically.  DiskInfo ignores other drives
  50. such as hard drives, IBM-type floppy drives, and so on.  Then, DiskInfo
  51. opens up a small window in the title-bar area of the WorkBench screen, and
  52. displays the drive names and free-blocks.  The window is sized according
  53. to the number of drives found by DiskInfo.
  54.  
  55.     While DiskInfo is running, it normally sleeps in the background.  By
  56. doing this, DiskInfo uses very little CPU time, and should not slow down
  57. your system to any noticable extent.  DiskInfo will wake up and update
  58. it's information when one of a few things happen:  you activate or
  59. deactivate the window (usually by clicking on it), or you swap a disk in
  60. any floppy drive.  Also, if you have enabled timed updates, DiskInfo will
  61. update it's information every "n-seconds."  (See "Options" for more info
  62. on this.)  Once this is done, DiskInfo goes back to sleep.
  63.  
  64.     If you are not using timed updates, sometimes the information shown by
  65. DiskInfo will be wrong.  For example, if you put an empty disk into a
  66. drive, and then copy over a number of files, DiskInfo will still report an
  67. empty disk.  If this happens, just click on the DiskInfo window to force
  68. the update.
  69.  
  70.     DiskInfo usually displays the number of free-blocks on each unit.  But
  71. sometimes DiskInfo shows other information in place of free-blocks:
  72.  
  73.     none  - There is no disk in the drive.
  74.     ???   - The disk is bad, blank, or some other unrecognized disk.
  75.     ffs   - The disk is a FFS-floppy, but the unit is not mounted as such.
  76.     kick  - The disk in the drive is a KickStart disk.
  77.     qbak  - The disk in the drive is a QuarterBack disk.
  78.  
  79.     If you activate DiskInfo's window, the title of the workbench screen
  80. will change to "DiskInfo v5.0".  When the window is active, you can hold
  81. down either mouse button, and DiskInfo will report what drives it is aware
  82. of.  This will be in the form of "DF0:  only" or "FF0:  also", indicating
  83. if it is aware of FFS-units mounted on a particular drive.  (Of course,
  84. DF0 and FF0 will be the proper names for your units.) This is displayed
  85. regardless of what disk is in each drive at the time.  If the DiskInfo
  86. window is dragable, you will have to use the right mouse button to see
  87. this information.
  88.  
  89.     It is possible to quit DiskInfo.  However, it is a bit awkward, and is
  90. intended to be this way.  This is because quitting DiskInfo when using
  91. FFS-floppies is NOT recommended.  To quit DiskInfo, first make sure the
  92. window is active.  Then, while holding down the right mouse button, press
  93. the delete key.  If DiskInfo does not find any FFS units, it will simply
  94. quit.  However, if there are FFS units, DiskInfo will put up an alert
  95. warning you about the dangers of quitting.  If you still wish to quit,
  96. press the left mouse button.  Pressing the right mouse button will keep
  97. DiskInfo running.  Do not be frightened by this alert; it is not a GURU!
  98. Since DiskInfo uses very little CPU time and ram (about 10K), there should
  99. be no reason to quit, especially when using FFS-floppies.  However, you
  100. may want to quit to change DiskInfo's options.
  101.  
  102.  
  103. OPTIONS
  104. -------
  105.     Starting DiskInfo, as explained above, will use the default settings.
  106. However, there are some command-line options to customize DiskInfo.  These
  107. options cannot be changed while DiskInfo is running; you will have to quit
  108. DiskInfo and then re-start it to change any option.  If you are using
  109. DiskInfo with FFS-floppies, it is suggested that you do not mount your FFS
  110. drives the first time you try DiskInfo.  This makes it easier to start and
  111. stop DiskInfo to try new options.  (See the above note about the alert
  112. shown when quitting DiskInfo.)  Once you have figured out the options you
  113. prefer, you can use DiskInfo as normal.  You might even include the
  114. DiskInfo command and options in your startup-sequence so that DiskInfo
  115. will be installed every time you boot.
  116.  
  117.     The options may be given in any order.  DiskInfo will use the last
  118. instance of an option if it is given more than once.  Any invalid options
  119. will result in the default value being used.  This means that unknown
  120. options will be used for the window's left edge.  If this is not a number,
  121. the default left edge will be used.  The letters used for the options may
  122. be upper or lower case.  Individual options should be seperated by spaces,
  123. but arguments to an option must follow it with no space in between.
  124.  
  125.     The format of the command-line options is:  (n is a number)
  126.  
  127.         DiskInfo <left-edge> D Cnnnn Tn
  128.  
  129.     left-edge - This specifies where DiskInfo will try to open it's window
  130.                 in relation to the WorkBench screen.  The normal WorkBench
  131.                 screen ranges from 0 to 640.  So a 0 for this value will
  132.                 cause the DiskInfo window to be at the left-most side of
  133.                 the screen.  If this value is not a positive number, the
  134.                 default value will be used.  If this value is too large,
  135.                 DiskInfo will open the window at the right-most side of
  136.                 the screen.  The default is 136.
  137.  
  138.     D         - This specifies that DiskInfo's window should be dragable.
  139.                 If you omit this option, the window will be 'stuck' in
  140.                 place.  It still might be possible to move the window with
  141.                 some other utiltiy such as Scripit.
  142.  
  143.     C         - This specifies the colour arangement that DiskInfo should
  144.                 use.  This is followed by up to four digits, symbolized by
  145.                 "n" above.  These tell DiskInfo which WorkBench colours to
  146.                 use for it's display.  0 is the first colour, 1 is the
  147.                 second, and so on.  The maximum value is one less than the
  148.                 number of colours on your WorkBench screen.  Normally,
  149.                 this ranges from 0 to 3.  An eight-colour screen would
  150.                 range from 0 to 7.  The colours are specified in order,
  151.                 but you do not need to specify all of them.  The order of
  152.                 the colours is:
  153.  
  154.                 background - Used for the titlebar.  Default = 0
  155.                 text       - Used for most of the text that DiskInfo
  156.                              displays.  Default = 1
  157.                 seperator  - Used for a bar seperating one drive's info
  158.                              from the next.  (Only shown if you have more
  159.                              than one floppy.)  Default = 2
  160.                 ffs-text   - Used for the name of a FFS unit.  Since the
  161.                              colour is different than the normal text, it
  162.                              is a bit more obvious when a FFS-floppy is in
  163.                              a drive.  Default = 3
  164.  
  165.                 DiskInfo will not allow you to set the same colour for the
  166.                 backgound and the text.  If you do, DiskInfo will choose a
  167.                 different value for the text.  This also applies to the
  168.                 ffs-text colour.
  169.  
  170.     T         - This enables timed updates.  Normally, in order to keep
  171.                 CPU use down to a minimum, DiskInfo only updates it's
  172.                 information when you activate/deactivate the window, or
  173.                 when you swap a disk in a drive.  When using timed
  174.                 updates, DiskInfo updates it's information every 'n'
  175.                 seconds.  Chances are, you won't notice a slow-down when
  176.                 using timed updates.  DiskInfo does not physically access
  177.                 the disk to get it's information, so there is very little
  178.                 overhead.  If you use 'T0', then DiskInfo will not do
  179.                 timed updates, which is the what happens when the T option
  180.                 is not used.  If you use T without any value, the default
  181.                 is to update every 10 seconds.
  182.  
  183.  
  184. EXAMPLES
  185. --------
  186.     DiskInfo t1 9999    - This sets up the window on the right side of the
  187.                           screen, with an update every second.
  188.  
  189.     DiskInfo 0 c0101 d  - This puts a dragable window on the left side of
  190.                           the screen.  The first two colours (background
  191.                           and text) are the defaults.  The seperator bar
  192.                           is the same colour as the background, thus it
  193.                           won't be visible.  The ffs-text is the same
  194.                           colour as the normal text.
  195.  
  196.     DiskInfo ?          - This does not print a help message.  Instead,
  197.                           "?" is taken as the left-edge since it is not
  198.                           any other known option.  Since this is not a
  199.                           positive number, it results in using the default
  200.                           value.
  201.  
  202.  
  203. CONSIDERATIONS
  204. --------------
  205.     If DiskInfo refuses to run, you should first make sure that the
  206. arp.library (v39 or higher) is in your LIBS: directory.  DiskInfo will
  207. also refuse to run if it can't open it's window, which might happen in
  208. low-memory situations.  (DiskInfo only uses about 10K of ram.)
  209.  
  210.     DiskInfo expects an 8-point font to be in use.  (Topaz, Siesta, etc.)
  211. If you a larger font, or 60-columns, the display will not adjust.  Maybe
  212. I'll fix this one day, maybe not.  For now, my apologies to anyone that
  213. needs DiskInfo to work with such a font.
  214.  
  215.     DiskInfo's window has no depth gadget.  But you can depth-arange it
  216. when using a utiltiy such as DMouse, QMouse, etc.  You can also use a
  217. utility such as Scripit to manipulate the DiskInfo window.  For this
  218. reason, DIskInfo's window has a title, although most of the time you will
  219. not see it.  The title is simply "DiskInfo".  (Note that there is no
  220. version number in this title.)
  221.  
  222.     DiskInfo is intended to work with WorkBench 1.3 only.  It should work
  223. with 2.0 as well.  But DiskInfo may not be as useful with 2.0 since the
  224. FastFileSystem is more integrated into the Operating System.
  225.  
  226.     Note that certain things do a "soft disk-change".  This means that the
  227. disk is changed without physically doing so.  One example would be
  228. formatting a brand new disk.  After this is done, DiskInfo will still
  229. report "???".  You may be able to get DiskInfo to recognize the new disk
  230. by clicking on the window.  Or, swapping a disk in another drive might
  231. cause the new disk to be recognized.  However, it is more likely that you
  232. will have to remove and then re-insert the disk.  Other things that do
  233. "soft disk-changes" include DiskChange, DiskCopy, and QuarterBack.
  234.  
  235.     DiskInfo will never print any error messages, due to the way DiskInfo
  236. releases it's hold on the CLI window.  But errors should not cause any
  237. problems.  DiskInfo will normally exit cleanly.  Some errors might cause
  238. DiskInfo to display the wrong information.  If this happens, click on the
  239. DiskInfo window, or swap a disk in a drive.  If the bad information
  240. persists, quit and re-start DiskInfo.
  241.  
  242.  
  243. DISKINFO & FFS
  244. --------------
  245.     As mentioned before, you do not need to use FFS-floppies with
  246. DiskInfo.  However, one of DiskInfo's main functions is to make using
  247. FFS-floppies with WorkBench 1.3 much easier.  There are a few things you
  248. should be aware of, in addition to the information provided below.
  249.  
  250.     DiskInfo performs a DiskChange on all drives that are mounted as FFS
  251. units.  If a drive is not mounted as such, the DiskChange is never done.
  252.  
  253.     When DiskInfo is first started, it finds any FFS units that have been
  254. mounted.  They will be found even if you omit "Mount=1" in your Mountlist.
  255. DiskInfo will then do a DiskChange on all FFS units it found.  So, do not
  256. be surprised when your drive lights come on after starting DiskInfo.
  257. After this, DiskInfo will do the DiskChange whenever a disk has been
  258. swapped in a FFS unit.  If you swap a disk in FF0:, for example, it will
  259. issue a DiskChange to that unit, but not to unit FF1:, FF2:, etc.  This
  260. DiskChange is based on the drive, and not what kind of disk is in the
  261. drive.
  262.  
  263.     It is suggested that you omit "Mount=1" from your MountList entries,
  264. and mount the FFS units *after* you start DiskInfo.  By doing this,
  265. DiskInfo will not know about the FFS unit when starting.  This will
  266. prevent DiskInfo from doing DiskChanges.  But the first time a FFS-floppy
  267. is placed in the drive, DiskInfo will see this, fully mount the unit, and
  268. begin doing DiskChanges.  By doing this, DiskInfo does a little less work
  269. until you actually begin to use FFS-floppies.  And you do not have to
  270. remember to type or do anything to use them; just insert a disk!
  271.  
  272.     DiskInfo will only display the first three letters of the unit's name,
  273. followed by a colon.  If you have a unit with a longer name, DiskInfo will
  274. still work with it, but the display will show an abbreviated name.  The
  275. name of a FFS unit is shown in a different colour to make it more obvious
  276. when a FFS-floppy is in a drive.  (Unless, of course, you cahnge this with
  277. the 'C' option.)
  278.  
  279.     Most importantly, under WorkBench 1.3, it is very important to do a
  280. DiskChange when a FFS-floppy is swapped.  If you don't, then you could
  281. risk damaging one or both disks that are swapped.  This is why DiskInfo
  282. puts up an alert before quitting.  If you must quit DiskInfo, it is
  283. strongly recommended that you stop using FFS-floppies, or have
  284. AutoDiskChange running to deal with disk swaps.  (DiskInfo will happily
  285. co-exist with AutoDiskChange.  In fact, DiskInfo should multitask with
  286. just about anything, including copies of itself!)
  287.  
  288.  
  289. FFS FLOPPIES
  290. ------------
  291.     This section provides more detailed information on the FastFileSystem
  292. and FFS floppies.  If you have used these before, you may skip this.
  293.  
  294.     With the release of WorkBench 1.3, Commodore introduced an alternative
  295. to the built-in File System called the FastFileSystem.  The advantages to
  296. this newer system are an increase in speed of disk access, and an increase
  297. in the amount of space available on a disk (roughly 5%, or 38k on a floppy
  298. disk.)  However, FFS was designed to be used only with non-removable media
  299. such as hard drives.  (This should change in 2.0)  You can use FFS with
  300. floppy drives, but there is one major problem.  The FFS does not expect
  301. disks to be changed, so if you do this, you could ruin the disk (either
  302. the one that was removed, the one that was inserted, or even both!)  If
  303. you use the DiskChange command, you can let FFS know that the disk has
  304. been changed.  However, it is very awkward to type this in every time you
  305. swap a disk.  Also, if you forget just once, you might destroy a disk (or
  306. disks!)
  307.  
  308.     The solution to this was provided by Martin Taillefer in the form of
  309. AutoDiskChange.  AutoDiskChange is a program that runs in the background,
  310. and issues a DiskChange command every time a disk is swapped in a FFS
  311. drive.  This is a very nice program; one which I have been using for quite
  312. a while.  However, there was still a problem with using FFS disks.  That
  313. problem was memory related...  not CHIP or FAST, but my memory.  I would
  314. often type "DF0:" when I meant "FF0:" and vice versa.  The solution to
  315. this was to write a program that would display what disk was in the drive
  316. at the time.  Once this was done, it became obvious that combining this
  317. with an AutoDiskChange-type feature would provide the best solution (until
  318. 2.0)
  319.  
  320.     To use FFS-floppies, you need to have FastFileSystem in your L:
  321. directory.  You will also need the Format command provided with WorkBench
  322. 1.3 or 1.32 to format disks using FFS.  It is recommended you use DiskInfo
  323. or AutoDiskChange (or both) for the reasons mentioned above.  Both
  324. programs require arp.library to be in your LIBS:  directory.  Finally, you
  325. will need to add an entry in your MountList file (in the DEVS: directory)
  326. for each FFS unit you intend to mount.
  327.  
  328.     To mount a FFS unit, you use the Mount command for each unit you want
  329. to use.  (If you use the ARP version of Mount, you can mount all units
  330. with one command.)  The unit must be mounted before you can use it in any
  331. way.  Once the unit has been mounted (and you have installed DiskInfo or
  332. AutoDiskChange) you can use it like any other drive by simply typing the
  333. name of the unit.  You can continue to use normal (OFS) disks in the drive
  334. by using the original name of the unit.
  335.  
  336.     For example, let's say that FF0: will be using unit 0 (DF0:)
  337.  
  338.     MOUNT FF0:          ; this mounts the unit
  339.     DiskInfo            ; to add the auto DiskChange feature
  340.     DIR DF0:            ; assuming a normal (OFS) disk is in there
  341.                         ; now put in a FFS-floppy...
  342.     DIR FF0:            ; and get a listing of the FFS-floppy
  343.  
  344.     If you wish to format FFS-floppies, you can do it like so:
  345.  
  346.     FORMAT DRIVE FF0: NAME "FFS-floppy" FFS
  347.  
  348.     Be sure to use the correct drive name for the format command.  If you
  349. format a FFS-floppy using "DF0:", it is possible that neither drive will
  350. recognize the disk, and you will have to re-format it.
  351.  
  352.     If you have the entry "Mount = 1" in your MountList, then the unit
  353. will be fully active when you mount it.  If you omit this entry, then you
  354. you must "wake up" the unit by doing "CD FF0:", "LIST FF0:", or something
  355. similar.  DiskInfo will also wake up the unit when it sees a FFS-floppy in
  356. it.  If you mount a unit (without "Mount = 1") before you run DiskInfo,
  357. then DiskInfo will "wake up" the unit immediately, and perform a
  358. DiskChange every time a disk is swapped.
  359.  
  360.     Most programs and commands work with FFS-floppies.  The main exception
  361. are those that explicitly ask for DF0:, etc.  But if you use FF0:  (or
  362. whatever the name of the unit is) when you have an OFS-floppy in there, or
  363. use DF0:  with a FFS-floppy, you will see a requester saying something
  364. like "Not a DOS disk".  Just click on cancel, and try again with the
  365. correct unit's name.  Hopefully, DiskInfo will lower the chance of this
  366. happening by reminding you what disk is in each drive.  This makes
  367. FFS-floppies much easier to deal with.  And once you start using them, it
  368. will be hard to go back to normal (OFS) disks and loose that extra storage
  369. space.
  370.  
  371.     The most important thing to consider while using FFS-floppies is disk
  372. swaps.  Besides using AutoDiskChange or DiskInfo, you should also make
  373. certain that the drive light is out before removing a disk.  Due to the
  374. way in which FFS caches information (which is one reason FFS is faster)
  375. the drive light sometimes comes back on for a brief moment.  So always
  376. wait a second or two before removing the disk.  This is not really a
  377. special precaution for FFS-floppies; it is a good idea to make sure that
  378. the drive is finished when using *any* floppy!
  379.  
  380.  
  381. PROGRAM NOTES
  382. -------------
  383.     Unlike AutoDiskChange, DiskInfo does not install a trackdisk interrupt
  384. which allows DiskInfo to be removed.  (Wouldn't it be nice if you could
  385. remove TD interrupts under 2.0? :-) )
  386.  
  387.     DiskInfo was written with Aztec C, v5.0a, ARP REL 3, and Maxwell House
  388. coffee.
  389.  
  390.     A brief history of DiskInfo follows:
  391.  
  392.     pre v 3.0    -  You don't want to know!
  393.     Version 3.x  -  AutoDiskChange feature added.  DiskInfo now finds
  394.                     units (OFS & FFS) automatically.
  395.     Version 4.0  -  Code tightened up.  Release to the public on Feb. 23,
  396.                     1990.
  397.     Version 4.0b -  Oops!  Now DiskInfo really does release it's hold on
  398.                     the CLI window, allowing you to EndCLI.
  399.     Version 4.1  -  Added a window title for Scripit, etc.
  400.     Version 5.0  -  This one.  Added timed updates, and changed the format
  401.                     of the command-line options.  Released on Apr 13, 1990.
  402.  
  403.  
  404. CREDITS, ETC.
  405. -------------
  406.     I would like to thank the following people:
  407.  
  408.     Jim Mak             - for beta-testing and various suggestions
  409.     Martin Taillefer    - for AutoDiskChange
  410.     Steve Tibbett       - for VirusX... a great program in addition to
  411.                           serving as my first real-world example of using
  412.                           the trackdisk.device
  413.     the ARP team        - the Amiga wouldn't be worth using without ARP!
  414.     the Roches          - for singing to me while I worked
  415.  
  416.  
  417.     Good luck with DiskInfo.  I hope it is of use to you.  I think you
  418. will find that DiskInfo makes using FFS-floppies with WorkBench 1.3
  419. almost second-nature.  When 2.0 is out, there may be a new version of
  420. DiskInfo.
  421.  
  422.     If you have any bugs to report, suggestions, or flames, you can
  423. contact me via:
  424.  
  425.     Amagination BBS (NYC)   Stan Ziel   212-727-3294
  426.     Elmhurst BBS (NYC)      Stan Ziel   718-803-0292
  427.     BIX                     sziel
  428.     UseNet                  (Soon, I hope!)
  429.  
  430.     SnailMail               19 Glenside Drive, New City, NY 10956 USA
  431.  
  432.  
  433.                                         - Stan, April 13, 1990
  434.  
  435. -----
  436.     "I just never knew how big nothing could be."
  437.